inspur.ispim.edit_smtp_dest module – Set SMTP information
Note
This module is part of the inspur.ispim collection (version 2.2.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install inspur.ispim
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: inspur.ispim.edit_smtp_dest
.
New in inspur.ispim 1.0.0
Synopsis
Set SMTP dest information on Inspur server.
Only the M6 models support this feature.
Requirements
The below requirements are needed on the host that executes this module.
Python 3.7+
inspursmsdk
Parameters
Parameter |
Comments |
---|---|
Email address. |
|
Description information. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Email destination id. Choices:
|
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
A dict object containing connection details. |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
|
Email enable. Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable |
Notes
Note
Does not support
check_mode
.
Examples
- name: Smtp dest test
hosts: ism
connection: local
gather_facts: no
vars:
ism:
host: "{{ ansible_ssh_host }}"
username: "{{ username }}"
password: "{{ password }}"
tasks:
- name: "Set smtp dest information"
inspur.ispim.edit_smtp_dest:
id: 1
status: "disable"
provider: "{{ ism }}"
- name: "Set smtp dest information"
inspur.ispim.edit_smtp_dest:
id: 1
status: "enable"
address: "100.2.2.2"
description": "test"
provider: "{{ ism }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Check to see if a change was made on the device. Returned: always |
|
Messages returned after module execution. Returned: always |
|
Status after module execution. Returned: always |